DocuGenerate fournit un accès sécurisé à son API grâce à l'utilisation de clés API, qui permettent aux développeurs d'accéder à la plateforme DocuGenerate et de l'intégrer dans leurs propres applications.
Vous pouvez obtenir votre clé API depuis la page Paramètres. Pour vous authentifier, la clé API doit être incluse dans toutes les requêtes API au serveur dans un en-tête qui ressemble à ceci :
Authorization: <Clé API>
Les modèles sont les éléments constitutifs de DocuGenerate, offrant un moyen de générer des documents de haute qualité avec une mise en forme cohérente. Avec les modèles, vous pouvez définir la structure de vos documents une seule fois, puis les utiliser de manière répétée pour générer de nouveaux documents selon vos besoins.
Pour créer un nouveau modèle, vous devez envoyer une requête POST à https://api.docugenerate.com/v1/template avec le paramètre file référençant le fichier modèle. Assurez-vous d'utiliser multipart/form-data comme type de contenu lors de la requête.
DocuGenerate répondra avec un objet JSON contenant les propriétés du modèle, incluant par exemple la liste des balises détectées.
curl -X 'POST' \
'https://api.docugenerate.com/v1/template' \
-H 'accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@Business Letter.docx;type=application/vnd.openxmlformats-officedocument.wordprocessingml.document' \
-F 'name=' \
-F 'delimiters={
"left": "[",
"right": "]"
}' \
-F 'region=us' \
-F 'enhanced_syntax=false' \
-F 'versioning_enabled=true'{
"enhanced_syntax": false,
"versioning_enabled": true,
"tags": {
"valid": [
"Date",
"Name",
"Job Title",
"Company Name",
"Street Address",
"City",
"State",
"Zip Code",
"Email",
"Phone"
],
"invalid": []
},
"created": 1748863881127,
"updated": 1748863881127,
"name": "Business Letter",
"delimiters": {
"left": "[",
"right": "]"
},
"filename": "Business Letter.docx",
"format": ".docx",
"region": "us",
"page_count": 1,
"image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.png?alt=media&token=d534d7f0-ccb6-4d6d-a9cf-7ffa55e82b95",
"preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.pdf?alt=media&token=8f60f256-c454-4ffc-a8da-670431a62e82",
"template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.docx?alt=media&token=0904bdf4-6046-4c03-a612-ebdf145fdee5",
"id": "bet2oQirk0pSd9ctH9Qu"
}
Vous générez des documents en envoyant une requête POST à https://api.docugenerate.com/v1/document avec les paramètres template_id et data. Le type de contenu multipart/form-data ou application/json peut être utilisé.
Le paramètre data doit être un tableau JSON avec les valeurs pour la fusion et la création de documents à partir du modèle, comme vous pouvez le voir dans l'exemple ci-dessous. Pour chaque objet du tableau, un document sera généré en remplaçant les balises de fusion par les valeurs de l'objet.
[
{
"Name": "Phip Crowch",
"Job Title": "Help Desk Operator",
"Company Name": "Ortiz Group",
"Street Address": "2971 Tomscot Avenue",
"City": "Annapolis",
"State": "Maryland",
"Zip Code": "21405",
"Email": "pcrowch0@disqus.com",
"Phone": "(443) 3819199"
}
]
D'autres paramètres comme output_name, output_format, single_file et page_break peuvent être spécifiés pour affiner la génération de documents.
curl -X 'POST' \
'https://api.docugenerate.com/v1/document' \
-H 'accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'template_id=bet2oQirk0pSd9ctH9Qu' \
-F 'output_quality=100' \
-F 'attach=' \
-F 'output_name=' \
-F 'data=[ { "Name": "Phip Crowch", "Job Title": "Help Desk Operator", "Company Name": "Ortiz Group", "Street Address": "2971 Tomscot Avenue", "City": "Annapolis", "State": "Maryland", "Zip Code": "21405", "Email": "pcrowch0@disqus.com", "Phone": "(443) 3819199" } ]' \
-F 'name=' \
-F 'merge_with=' \
-F 'page_break=true' \
-F 'single_file=true' \
-F 'output_format=.pdf' DocuGenerate répondra avec un objet JSON contenant les propriétés du document, notamment document_uri qui pointe vers l'URL du document généré. Le output_format du document généré peut être .docx, .pdf, .doc, .odt ou .txt. Il convient de noter que le temps de traitement est le plus rapide pour le format .docx. Pour les autres formats, une étape de conversion supplémentaire est nécessaire, ce qui augmente le temps de réponse global.
{
"created": 1748865212803,
"template_id": "bet2oQirk0pSd9ctH9Qu",
"name": "Business Letter",
"format": ".pdf",
"data_length": 1,
"filename": "Business Letter.pdf",
"document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FX5KpzgaMuNoGyiExDum8%2FBusiness%20Letter.pdf?alt=media&token=9c3eaddf-db30-47c5-a3ad-54bdda1d5915",
"id": "X5KpzgaMuNoGyiExDum8"
}
Vous pouvez trouver une liste complète de tous les endpoints disponibles, incluant des informations sur les paramètres du corps de la requête et les schémas de réponse sur la page Référence API.
Ces endpoints constituent le fondement de la plateforme DocuGenerate, fournissant un ensemble complet d'outils pour gérer les templates et les documents. En exploitant ces ressources, vous pouvez facilement créer des flux de génération de documents robustes qui peuvent être personnalisés pour répondre aux besoins spécifiques de votre organisation.
Si vous avez des questions sur l'utilisation de l'API de DocuGenerate, vous trouverez une multitude de ressources utiles dans notre Centre d'Aide. Il contient des articles essentiels qui vous aideront à intégrer parfaitement notre API dans vos applications.
Nous recommandons vivement de consulter les articles Tester l'API avec Postman et Tester l'API avec la Référence API pour des instructions étape par étape pour vous aider à démarrer efficacement les tests de l'API.
